Vcenter Authorization Roles Info

Vcenter Authorization Roles Info
Vcenter Authorization Roles Info

The Vcenter Authorization Roles Info schema contains detailed information about a specific role.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "name": "string",
    "description": "string",
    "privileges": [
        "string"
    ],
    "system": false
}
string
name
Required

The name of the role.

This property was added in vSphere API 9.0.0.0.

string
description
Required

A brief summary what this role is dedicated for.

This property was added in vSphere API 9.0.0.0.

array of string
privileges
Required

The set of Vcenter Authorization Privileges which are part of this role.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.authorization.Privilege. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.authorization.Privilege.

boolean
system
Required

Indicator if role is created as system built-in role.

This property was added in vSphere API 9.0.0.0.